

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>pyamp.ui.qt.baseView &mdash; pyamp v1.2 documentation</title>
    <link rel="stylesheet" href="../../../../_static/default.css" type="text/css" />
    <link rel="stylesheet" href="../../../../_static/pygments.css" type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '../../../../',
        VERSION:     '1.2',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="../../../../_static/jquery.js"></script>
    <script type="text/javascript" src="../../../../_static/underscore.js"></script>
    <script type="text/javascript" src="../../../../_static/doctools.js"></script>
    <link rel="top" title="pyamp v1.2 documentation" href="../../../../index.html" />
    <link rel="up" title="pyamp.ui.qt" href="../qt.html" /> 
  </head>
  <body>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../../../../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="../../../../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li><a href="../../../../index.html">pyamp v1.2 documentation</a> &raquo;</li>
          <li><a href="../../../index.html" >Module code</a> &raquo;</li>
          <li><a href="../qt.html" accesskey="U">pyamp.ui.qt</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <h1>Source code for pyamp.ui.qt.baseView</h1><div class="highlight"><pre>
<span class="c"># Copyright 2012 Brett Ponsler</span>
<span class="c"># This file is part of pyamp.</span>
<span class="c">#</span>
<span class="c"># pyamp is free software: you can redistribute it and/or modify</span>
<span class="c"># it under the terms of the GNU General Public License as published by</span>
<span class="c"># the Free Software Foundation, either version 3 of the License, or</span>
<span class="c"># (at your option) any later version.</span>
<span class="c">#</span>
<span class="c"># pyamp is distributed in the hope that it will be useful,</span>
<span class="c"># but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<span class="c"># MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the</span>
<span class="c"># GNU General Public License for more details.</span>
<span class="c">#</span>
<span class="c"># You should have received a copy of the GNU General Public License</span>
<span class="c"># along with pyamp.  If not, see &lt;http://www.gnu.org/licenses/&gt;.</span>
<span class="sd">&#39;&#39;&#39;The baseView module contains the BaseView class which provides a base</span>
<span class="sd">framework for more easily creating and using Qt objects.</span>

<span class="sd">&#39;&#39;&#39;</span>
<span class="kn">from</span> <span class="nn">pyamp.logging</span> <span class="kn">import</span> <span class="n">Loggable</span><span class="p">,</span> <span class="n">Colors</span>
<span class="kn">from</span> <span class="nn">pyamp.patterns</span> <span class="kn">import</span> <span class="n">RequiredProperties</span>


<div class="viewcode-block" id="BaseView"><a class="viewcode-back" href="../../../../_generated/pyamp_ui_qt_baseView.html#pyamp.ui.qt.baseView.BaseView">[docs]</a><span class="k">class</span> <span class="nc">BaseView</span><span class="p">(</span><span class="n">Loggable</span><span class="p">,</span> <span class="n">RequiredProperties</span><span class="p">):</span>
    <span class="sd">&#39;&#39;&#39;The BaseView class provides a base framework for creating Qt</span>
<span class="sd">    objects.</span>

<span class="sd">    It provides several functions that are called in a specific order,</span>
<span class="sd">    and are to be overridden by subclasses in order to provide a</span>
<span class="sd">    specific implementation for the BaseView. These functions pertain</span>
<span class="sd">    to certain aspects of setting up a view and are called in the</span>
<span class="sd">    following order:</span>

<span class="sd">    1. configure()</span>
<span class="sd">    2. createLayout()</span>
<span class="sd">    3. configureLayout()</span>
<span class="sd">    4. setupView()</span>
<span class="sd">    5. setupConnections()</span>

<span class="sd">    This class implements the :class:`pyamp.logging.Loggable` interface</span>
<span class="sd">    and provides the ability to specify the :attr:`logData` object</span>
<span class="sd">    as well as the :attr:`color` to use for logging (the default</span>
<span class="sd">    color is to use a white foreground color).</span>

<span class="sd">    &#39;&#39;&#39;</span>

    <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">controller</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">mainWindow</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span>
                 <span class="n">logData</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">logColor</span><span class="o">=</span><span class="n">Colors</span><span class="o">.</span><span class="n">Foreground</span><span class="o">.</span><span class="n">White</span><span class="p">):</span>
        <span class="sd">&#39;&#39;&#39;</span>
<span class="sd">        * name -- The name of the BaseView</span>
<span class="sd">        * controller -- The controller for the BaseView</span>
<span class="sd">        * mainWindow -- The main window</span>
<span class="sd">        * logData -- The LogData object</span>
<span class="sd">        * logColor -- The color to use for the logger</span>

<span class="sd">        &#39;&#39;&#39;</span>
        <span class="c"># Use the class name if there was no name provided</span>
        <span class="k">if</span> <span class="n">name</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
            <span class="n">name</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__class__</span><span class="o">.</span><span class="n">__name__</span>

        <span class="c"># Create the loggable interface</span>
        <span class="n">Loggable</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">logData</span><span class="p">,</span> <span class="n">logColor</span><span class="p">)</span>
        <span class="n">RequiredProperties</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>

        <span class="c"># Store the given parameters</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">name</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">controller</span> <span class="o">=</span> <span class="n">controller</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">mainWindow</span> <span class="o">=</span> <span class="n">mainWindow</span>

        <span class="c"># Configure the size for this view</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">configure</span><span class="p">()</span>

        <span class="c"># Create and configure the main layout for this class</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">createLayout</span><span class="p">()</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">configureLayout</span><span class="p">()</span>

        <span class="c"># Create and set up the view</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">setupView</span><span class="p">()</span>

        <span class="c"># Now set up any connections for this view</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">setupConnections</span><span class="p">()</span>

        <span class="c"># Complete any commands to complete the setup</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">completeSetup</span><span class="p">()</span>

    <span class="c">##### Functions to be overridden by the subclass #####</span>

<div class="viewcode-block" id="BaseView.setupView"><a class="viewcode-back" href="../../../../_generated/pyamp_ui_qt_baseView.html#pyamp.ui.qt.baseView.BaseView.setupView">[docs]</a>    <span class="k">def</span> <span class="nf">setupView</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&#39;&#39;&#39;Create and set up this view.</span>

<span class="sd">        .. note:: This function should be overridden by subclasses.</span>

<span class="sd">        &#39;&#39;&#39;</span>
        <span class="k">pass</span>
</div>
<div class="viewcode-block" id="BaseView.configure"><a class="viewcode-back" href="../../../../_generated/pyamp_ui_qt_baseView.html#pyamp.ui.qt.baseView.BaseView.configure">[docs]</a>    <span class="k">def</span> <span class="nf">configure</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&#39;&#39;&#39;Configure the view.</span>

<span class="sd">        .. note:: This function should be overridden by subclasses.</span>

<span class="sd">        &#39;&#39;&#39;</span>
        <span class="k">pass</span>
</div>
<div class="viewcode-block" id="BaseView.createLayout"><a class="viewcode-back" href="../../../../_generated/pyamp_ui_qt_baseView.html#pyamp.ui.qt.baseView.BaseView.createLayout">[docs]</a>    <span class="k">def</span> <span class="nf">createLayout</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&#39;&#39;&#39;Create the main layout.</span>

<span class="sd">        .. note:: This function should be overridden by subclasses.</span>

<span class="sd">        &#39;&#39;&#39;</span>
        <span class="k">pass</span>
</div>
<div class="viewcode-block" id="BaseView.configureLayout"><a class="viewcode-back" href="../../../../_generated/pyamp_ui_qt_baseView.html#pyamp.ui.qt.baseView.BaseView.configureLayout">[docs]</a>    <span class="k">def</span> <span class="nf">configureLayout</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&#39;&#39;&#39;Configure the layout for this view.</span>

<span class="sd">        .. note:: This function should be overridden by subclasses.</span>

<span class="sd">        &#39;&#39;&#39;</span>
        <span class="k">pass</span>
</div>
<div class="viewcode-block" id="BaseView.setupConnections"><a class="viewcode-back" href="../../../../_generated/pyamp_ui_qt_baseView.html#pyamp.ui.qt.baseView.BaseView.setupConnections">[docs]</a>    <span class="k">def</span> <span class="nf">setupConnections</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&#39;&#39;&#39;Set up any connections this view requires.</span>

<span class="sd">        .. note:: This function should be overridden by subclasses.</span>

<span class="sd">        &#39;&#39;&#39;</span>
        <span class="k">pass</span>
</div>
<div class="viewcode-block" id="BaseView.completeSetup"><a class="viewcode-back" href="../../../../_generated/pyamp_ui_qt_baseView.html#pyamp.ui.qt.baseView.BaseView.completeSetup">[docs]</a>    <span class="k">def</span> <span class="nf">completeSetup</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="sd">&#39;&#39;&#39;Finish setting up the view.</span>

<span class="sd">        .. note:: This function should be overridden by subclasses.</span>

<span class="sd">        &#39;&#39;&#39;</span>
        <span class="k">pass</span>
</div>
<div class="viewcode-block" id="BaseView.setController"><a class="viewcode-back" href="../../../../_generated/pyamp_ui_qt_baseView.html#pyamp.ui.qt.baseView.BaseView.setController">[docs]</a>    <span class="k">def</span> <span class="nf">setController</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">controller</span><span class="p">):</span>
        <span class="sd">&#39;&#39;&#39;Set the controller object for this view.</span>

<span class="sd">        * controller -- The controller</span>

<span class="sd">        &#39;&#39;&#39;</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">controller</span> <span class="o">=</span> <span class="n">controller</span></div></div>
</pre></div>

          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
<div id="searchbox" style="display: none">
  <h3>Quick search</h3>
    <form class="search" action="../../../../search.html" method="get">
      <input type="text" name="q" size="18" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
    <p class="searchtip" style="font-size: 90%">
    Enter search terms or a module, class or function name.
    </p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../../../../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="../../../../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li><a href="../../../../index.html">pyamp v1.2 documentation</a> &raquo;</li>
          <li><a href="../../../index.html" >Module code</a> &raquo;</li>
          <li><a href="../qt.html" >pyamp.ui.qt</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright 2012, Brett Ponsler.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.1.
    </div>
  </body>
</html>